Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for ExtPtfm #858

Merged
merged 2 commits into from
Oct 15, 2021
Merged

Documentation for ExtPtfm #858

merged 2 commits into from
Oct 15, 2021

Conversation

ebranlard
Copy link
Contributor

This pull request is ready to be merged

Feature or improvement description
Documentation added. A live version is available here:
https://ebranlard-openfast.readthedocs.io/en/f-extptfm-doc/source/user/extptfm/index.html

Related pull request
#344

Related issues
#852
#549
#485

@codecov-commenter
Copy link

codecov-commenter commented Oct 6, 2021

Codecov Report

Merging #858 (af93cc4) into dev (7a59bec) will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##              dev     #858      +/-   ##
==========================================
+ Coverage   11.27%   11.28%   +0.01%     
==========================================
  Files         211      211              
  Lines      309733   310488     +755     
  Branches   180530   181011     +481     
==========================================
+ Hits        34910    35054     +144     
- Misses     230900   231363     +463     
- Partials    43923    44071     +148     
Flag Coverage Δ
regtests 11.18% <ø> (+0.01%) ⬆️
unittests 2.57% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
modules/subdyn/src/SubDyn_Driver.f90 42.20% <0.00%> (-17.80%) ⬇️
modules/subdyn/src/SubDyn.f90 28.66% <0.00%> (-1.22%) ⬇️
modules/subdyn/src/Yaml.f90 6.65% <0.00%> (-1.19%) ⬇️
modules/openfast-library/src/FAST_Subs.f90 19.16% <0.00%> (-0.01%) ⬇️
modules/openfast-library/src/FAST_Solver.f90 9.35% <0.00%> (-0.01%) ⬇️
modules/subdyn/src/FEM.f90 46.62% <0.00%> (ø)
modules/nwtc-library/src/NWTC_IO.f90 26.42% <0.00%> (ø)
modules/openfast-library/src/FAST_Lin.f90 0.00% <0.00%> (ø)
modules/subdyn/src/SubDyn_Types.f90 5.78% <0.00%> (+0.04%) ⬆️
modules/subdyn/src/SubDyn_Output.f90 21.13% <0.00%> (+0.32%) ⬆️
... and 1 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7a59bec...af93cc4. Read the comment docs.

Copy link
Collaborator

@jjonkman jjonkman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ebranlard -- Thank you for developing this documentation. Overall, an excellent documentation of the ExtPtfm module! Please find a few minor edits/corrections here. After these are addressed, please merge.

docs/source/user/extptfm/usage.rst Outdated Show resolved Hide resolved
docs/source/user/extptfm/usage.rst Outdated Show resolved Hide resolved
docs/source/user/extptfm/usage.rst Outdated Show resolved Hide resolved
docs/source/user/extptfm/usage.rst Outdated Show resolved Hide resolved
docs/source/user/extptfm/input_files.rst Outdated Show resolved Hide resolved
docs/source/user/extptfm/input_files.rst Outdated Show resolved Hide resolved
docs/source/user/extptfm/input_files.rst Show resolved Hide resolved
docs/source/user/extptfm/input_files.rst Outdated Show resolved Hide resolved
docs/source/user/extptfm/theory.rst Show resolved Hide resolved
docs/source/user/extptfm/theory.rst Show resolved Hide resolved
Copy link
Collaborator

@jjonkman jjonkman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing my edits/comments!

@ebranlard ebranlard merged commit da7a714 into OpenFAST:dev Oct 15, 2021
@ebranlard ebranlard deleted the f/extptfm-doc branch November 12, 2021 19:23
@rafmudaf rafmudaf mentioned this pull request Mar 2, 2022
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants